home *** CD-ROM | disk | FTP | other *** search
/ Aminet 6 / Aminet 6 - June 1995.iso / Aminet / disk / bakup / Backman023b.lha / BackManMUI.Doc < prev    next >
Encoding:
Text File  |  1995-02-15  |  12.0 KB  |  277 lines
  1.  
  2.              BackManMUI v0.x
  3.           - The backup system -
  4.  
  5.         Preliminary documentation
  6.         ~~~~~~~~~~~~~~~~~~~~~~~~~
  7.  
  8.  
  9. 0. IMPORTANT NOTES
  10. ~~~~~~~~~~~~~~~~~~
  11. THIS DOCUMENT IS VERY PRELIMINARY, AND IS INTENDED ONLY TO GIVE SOME ROUGH
  12. INSTRUCTIONS TO BETA TESTERS. THE REAL DOCUMENTATION WILL COME WHEN THE
  13. PROGRAM WILL BE CLOSER TO COMPLETION.
  14.  
  15. As a consequence, usage of beta versions of this program is not recommended
  16. to unexperienced users: blowing up your hard disk by improper use of this
  17. program is your very own problem, so think twice before using this program
  18. without proper care and knowledge.
  19.  
  20. PLEASE DON'T MAKE IMPORTANT BACKUPS WITH THIS VERSION! DISK FORMAT IS SUBJECT
  21. TO CHANGE (AND WILL DO, BE SURE), SO LATER VERSIONS MAY NOT BE ABLE TO
  22. RESTORE OLD BACKUPS! Or at least keep this version somewhere, but don't say
  23. we didn't tell you if you lose your data.
  24.  
  25. This version of BackMan still includes some debugging code: please report any
  26. "strange" message you might see (mostly of the kind "Assertion is false!",
  27. followed by several lines of programmer's information), with the most
  28. complete description of the conditions in which it was displayed, and if
  29. possible send us a sample backup that shows the problem.
  30.  
  31. This document is updated only when time permits. Don't rely too much on the
  32. information contained herein; on the other side, please report any error, and
  33. feel free to contact the authors for any misunderstanding.
  34.  
  35. Please read the chapter entitled "NO WARRANTY" in the file "BackMan.Doc"
  36. before you even think about running this program.
  37.  
  38.  
  39. 1. Requirements
  40. ~~~~~~~~~~~~~~~
  41. BackMan requires Release 2.04 or later of the Amiga OS to run. If you didn't
  42. upgrade yet, then it's definitely time to do it: you are missing lots of new
  43. features and good software, and you're holding Amiga technology behind.
  44.  
  45. BackManMUI, as its name implies, uses and requires MagicUserInterface by
  46. Stefan Stuntz, version 2.2 or later (the appropriate copyright notice will be
  47. added in a later release of this doc; it is however fully acknowledged by the
  48. authors). We will assume that MUI is already installed and working on your
  49. system. MUI is *NOT* distributed with BackMan: you can get it through various
  50. public domain/freeware/shareware collections, through electronic networks, or
  51. directly from the author.
  52.  
  53. MUI has many advantages over other user interfaces, in primis over the
  54. system-supplied GadTools library, especially from a programmer's point of
  55. view: the supposed slowness and space requirements of MUI are definitely
  56. worth it. If you didn't try it out yet, please do: you will be impressed.
  57.  
  58. BackMan supports the MultiUserFileSystem by Geert Uytterhoeven (the same
  59. considerations on copyright apply), and to the knowledge of the authors it is
  60. the only backup program with such support. MultiUser support requires
  61. multiuser.library V39+ and dos.library V39+.
  62.  
  63. BackMan supports data compression through the XPK libraries, created by Urban
  64. Dominik Müller, Bryan Ford and others, and copyrighted by its authors.
  65.  
  66.  
  67. 2. Installation
  68. ~~~~~~~~~~~~~~~
  69. To install BackMan, simply extract the archive where you prefer: you should
  70. use the 'x' command of LhA to extract full paths. Make sure the Images drawer
  71. is present in the same path of BackManMUI.
  72.  
  73. As mentioned above, MUI must already have been installed on your system in
  74. order for BackManMUI to work.
  75.  
  76.  
  77. 3. Limitations
  78. ~~~~~~~~~~~~~~
  79. Backup/Restore is limited to about 4 Mbytes for unregistered users.
  80.  
  81.  
  82. 4. Windows
  83. ~~~~~~~~~~
  84. We will now describe the various windows of BackManMUI.
  85.  
  86. 4.1. The Main window
  87. ~~~~~~~~~~~~~~~~~~~~
  88. This is the fist window to appear when you run BackManMUI. Here you can
  89. select what operation to perform.
  90.  
  91. You should already know the "About..." part, as it gets displayed for 30
  92. seconds if you're not a registered user.
  93.  
  94. The only option that needs clarification is "Diff": this operation will read
  95. the catalog from the backup and check the file attributes (size, date,
  96. comment, protection, etc.) against those on your drive. It was inspired by
  97. the 'h' command of LhA by Stefan Boberg.
  98.  
  99. Hereafter we will reference Restore, Compare or Diff as "restore operations",
  100. because they all imply restoring some amount of information from the backup
  101. to your computer, and because the options that apply to these operations are
  102. almost the same.
  103.  
  104. 4.2. The Configuration window
  105. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  106. The first thing you have to do is to bring up the configuration window by
  107. pressing the "Configure..." button in the main window or by selecting the
  108. appropriate menu item.
  109.  
  110. The configuration window is subdivided in two sections: the general options
  111. and the backup medium options. Each section is further subdivided into
  112. several groups, which are:
  113.  - "General", "Backup" and "Restore" for the options, and
  114.  - "Tape/Removable" (not yet implemented), "Floppy disks" and "File" for the
  115.    backup medium.
  116.  
  117. The options seem obvious enough for the aforementioned experienced users.
  118. Please read "BackMan.Doc" for some more hints.
  119.  
  120. Only some notices: the drive list supports more than one device (they appear
  121. separated by commas, as in "DF0,DF1"), but the internal routines don't, so
  122. restrict yourself to one device. Moreover, be careful not to select your hard
  123. disk as the backup device unless you know very well what you're doing, or you
  124. might get really upset by the results.
  125.  
  126. *All* disk devices that have a valid DOS device entry are suported: this
  127. includes CrossDOS disks, DiskSpare disks, hard disks (of which removable
  128. cartridges such as SyQuest drives are a subset), most recoverable RAM drives
  129. (I wouldn't recommend them as backup devices, however). HD floppies are
  130. supported, but you should insert an HD disk *before* you start the backup.
  131.  
  132. 4.3. The Backup window
  133. ~~~~~~~~~~~~~~~~~~~~~~
  134. Here you select which files you want to backup.
  135.  
  136. You can backup more than one directory tree at a time by clicking the
  137. "Add..." button and selecting a new directory.
  138.  
  139. You can remove a catalog from the backup by selecting it and clicking the
  140. "Remove" button (you will be asked for confirmation).
  141.  
  142. By double-clicking on an entry in the catalog list you can bring up the file
  143. selection window or change the comment for this catalog, depending on wich
  144. field you double-click. These options are also available as buttons just
  145. below the catalog list. Experiment as you wish, you can't do anything harmful
  146. at this stage.
  147.  
  148. The backup creator is global for all catalogs. It is taken from the
  149. registration key if you have one, but you can change it as you wish.
  150.  
  151. Selecting "Start" will start the backup. Please double-check that you
  152. selected the proper destination medium, or you could overwrite the very same
  153. files you're trying to backup.
  154.  
  155. 4.4. The Restore/Compare/Diff window
  156. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  157. You will get here after BackMan has read the catalog from the backup, which
  158. usually doesn't take more than a few seconds. The window title shows which
  159. kind of operation you're performing.
  160.  
  161. Basically, here you can select catalogs/files to operate on and change the
  162. destination directory, which by default is set to the same directory the
  163. files originally came from: not much difference from the Backup window.
  164. Again, you can't do any harm here, so experiment at will.
  165.  
  166. 4.5. The File Selection window
  167. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  168. This window can be accessed from the Backup and Restore/Compare/Diff windows,
  169. and it is used to select which files in a catalog to operate on.
  170.  
  171. 4.5.1. The Filter window
  172. ~~~~~~~~~~~~~~~~~~~~~~~~
  173. The Filter window will appear by clicking on the "Filter..." button in the
  174. File Selection window: here you can select or unselect several files at once,
  175. by attribute or using wildcards, in the current drawer only or including all
  176. its subdirectories. The Filter window remains open together with the File
  177. Selection window until you close it: in other words you can keep them open
  178. together and alternate manual file (de)selection and multiple (de)selection
  179. through the Filter window without the need to open/close it every time.
  180.  
  181. 4.6. The Status window
  182. ~~~~~~~~~~~~~~~~~~~~~~
  183. This window comes up after you select "Start" from the Backup or
  184. Restore/Compare/Diff windows. It will show you the progress of the operation
  185. you're doing by displaying the directory and file being operated on and some
  186. counters that tell you how many files/bytes have been read or written as yet.
  187.  
  188. Here you can only pause/restart or abort the operation.
  189.  
  190. If you are doing a compressed backup, at the bottom of the status window
  191. there will be a gauge showing the compression ratio. The ratio is calulated
  192. as PackedSize/RealSize, so higher is better.
  193.  
  194.  
  195. 5. Data Compression and Encryption
  196. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  197. In order to take advantage of data compression and encryption you need the
  198. XPK package, a set of freely distributable shared libraries created by Urban
  199. Dominik Müller, Bryan Ford and others. XPK offers many features, among which
  200. there are several different compression and encryption algorythms and an easy
  201. programming interface. XPK libraries have become a standard for compression
  202. in the Amiga world.
  203.  
  204. Data compression can greatly reduce the amount of space needed for a backup.
  205. The effective compression rate depends on the compression algorythm you
  206. choose in the configuration: the available XPK libraries offer a wide range
  207. of compressors, and most of them will give you an average 30% compression,
  208. provided that the files being backed up are not already compressed with
  209. commonly used file compressors such as PowerPacker or archivers such as Lha.
  210.  
  211. On slow backup media such as floppy disks, data compression can also increase
  212. the backup and restore speed, because in such situations the performance
  213. bottleneck is the slowness of the backup device: the time gain obtained by
  214. reading or writing less data can overcome the time waste required by data
  215. compression, especially on faster processors.
  216.  
  217. To create a compressed backup, simply check the appropriate button in the
  218. "Backup" configuration group: as already mentioned, a gauge in the Status
  219. window will show the achieved compression ratio as the backup proceeds.
  220.  
  221. To restore a compressed backup, you have to do nothing particular: BackMan
  222. does recognize by itself that the backup is compressed and does automatically
  223. perform all the appropriate operations. There is only one point to mention:
  224. you should take care of inserting the last backup disk instead of the first,
  225. as suggested by the requester that asks you for a disk, because the file list
  226. on the first disk does not contain full informations on the compressed files.
  227. See "Internals/Compression issues" for more information.
  228.  
  229.  
  230. 6. Internals
  231. ~~~~~~~~~~~~
  232. This chapter describes some internal characteristics of BackMan and is
  233. intended to help advanced users to get the best out of BackMan.
  234.  
  235. 6.1. The Order of Things in the backup
  236. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  237. The backup is organized in this way:
  238.  - primary file list;
  239.  - data, subdivided in blocks;
  240.  - secondary file list.
  241.  
  242. Entries are written in alphabetical order, files first, then each directory
  243. with all its subentries.
  244.  
  245. Data is written in fixed-size blocks, eventually compressed.
  246.  
  247. 6.2. Compression issues
  248. ~~~~~~~~~~~~~~~~~~~~~~~
  249. If you do a compressed backup, the primary list will not contain informations
  250. on the compressed size of data, so a partial restore operation will need to
  251. read all the files in order to find out where the needed files are located.
  252. This will not slow down the restore operation too much, because there is no
  253. need to really decompress data: we only need to read the block headers.
  254.  
  255. However, if you plan to do a partial restore, insert the last disk of a
  256. backup: BackMan will read in the secondary list, which contains all the
  257. informations needed to skip exactly to the beginning of selected files.
  258.  
  259. Please note that all operations are permitted even if BackMan has read the
  260. first (incomplete) list: they will only be slower and less comfortable
  261. because you will need to insert all disks. Also, non-compressed backups are
  262. not affected by which list has ben read.
  263.  
  264.  
  265. 42. The Authors
  266. ~~~~~~~~~~~~~~~
  267. BackMan was written by
  268.  
  269.   Sandro Tolaini    2:332/113.3@fidonet
  270.                     39:102/507.3@amiganet
  271.  
  272.   Flavio Stanchina  2:333/408.9@fidonet
  273.  
  274. Contact us for any question/suggestion/bug report.
  275.  
  276.  
  277.